Calendar#

The Calendar API in the Scripting app provides access to iOS calendars, calendar accounts, and event/reminder management.
Developers can retrieve default calendars, create new ones, list calendars supporting specific entity types, and manage calendar properties.

#Type Definitions

#CalendarType

Represents types of calendars:

#CalendarSourceType

Represents the type of calendar account source:

#CalendarEventAvailability

Represents event availability settings:

#CalendarEntityType

Represents types of entities calendars can manage:

#Class: CalendarSource

Represents a calendar account source (e.g., Local, Exchange).

#Properties

#Methods

#getCalendars(entityType: CalendarEntityType): Promise<Calendar[]>

Gets the list of calendars for this source based on entity type.

• Parameters
  • entityType: CalendarEntityType — The entity type to retrieve.
• Returns
  • Promise<Calendar[]> — An array of calendar objects.

#Class: Calendar

Represents a calendar object that manages events and reminders.

#Properties

#Methods

#remove(): Promise<void>

Deletes the calendar.

#save(): Promise<void>

Saves changes to the calendar.

#static defaultForEvents(): Promise<Calendar | null>

Gets the default event calendar set by the system.

#static defaultForReminders(): Promise<Calendar | null>

Gets the default reminder calendar set by the system.

#static forEvents(): Promise<Calendar[]>

Lists all calendars that support events.

#static forReminders(): Promise<Calendar[]>

Lists all calendars that support reminders.

#static create(options: { title: string, entityType: CalendarEntityType, sourceType: CalendarSourceType, color?: Color }): Promise<Calendar>

Creates a new calendar.

• Parameters
  • title: string — Calendar title
  • entityType: CalendarEntityType — Supported entity type
  • sourceType: CalendarSourceType — Account source type
  • color?: Color — (Optional) Calendar color
• Returns
  • Promise<Calendar> — The newly created calendar.

#static presentChooser(allowMultipleSelection?: boolean): Promise<Calendar[]>

Presents a calendar chooser view.

• Parameters
  • allowMultipleSelection?: boolean — Allow multiple selection, default false.
• Returns
  • Promise<Calendar[]> — Selected calendars.

#static getSources(): CalendarSource[]

Retrieves all available calendar sources on the device.

#Example Code

#Retrieve Default Event Calendar

const defaultEventCalendar = await Calendar.defaultForEvents()
if (defaultEventCalendar) {
  console.log(`Default event calendar: ${defaultEventCalendar.title}`)
} else {
  console.log('No default event calendar found')
}

#Create a New Local Event Calendar

const newCalendar = await Calendar.create({
  title: 'Workout Schedule',
  entityType: 'event',
  sourceType: 'local',
  color: '#FF5733'
})

await newCalendar.save()
console.log(`Created new calendar: ${newCalendar.title}`)

#List All Event-Supporting Calendars

const eventCalendars = await Calendar.forEvents()
for (const calendar of eventCalendars) {
  console.log(`Calendar: ${calendar.title}`)
}

#Delete the First Event Calendar

const eventCalendars = await Calendar.forEvents()
if (eventCalendars.length > 0) {
  const calendarToRemove = eventCalendars[0]
  await calendarToRemove.remove()
  console.log(`Removed calendar: ${calendarToRemove.title}`)
}

#Present Calendar Chooser

const selectedCalendars = await Calendar.presentChooser(true)
for (const calendar of selectedCalendars) {
  console.log(`Selected calendar: ${calendar.title}`)
}